Class DerivedClassScanner

Summary

Fully Qualified Name: Laminas\Code\Scanner\DerivedClassScanner
Extends: ClassScanner

Description

Methods

Name Description Defined By
__construct() DerivedClassScanner
__toString() ClassScanner
export() ClassScanner
getAnnotations() Get annotations ClassScanner
getConstant() Return a single constant by given name or index of info DerivedClassScanner
getConstantNames() Return a list of constant names DerivedClassScanner
getConstants() Return a list of constants DerivedClassScanner
getDocBlock() Return documentation block ClassScanner
getDocComment() Return documentation comment ClassScanner
getInterfaces() DerivedClassScanner
getLineEnd() Return number of last line ClassScanner
getLineStart() Return number of first line ClassScanner
getMethod() DerivedClassScanner
getMethodNames() DerivedClassScanner
getMethods() DerivedClassScanner
getName() DerivedClassScanner
getParentClass() DerivedClassScanner
getParentClasses() DerivedClassScanner
getProperties() DerivedClassScanner
getProperty() Return a single property by given name or index of info DerivedClassScanner
getPropertyNames() Return a list of property names DerivedClassScanner
getShortName() DerivedClassScanner
getTraitAliases() Retrieve a list of aliased traits used by the class. ClassScanner
getTraitNames() Retrieve a list of trait names used by this class. ClassScanner
getTraits() Retrieve any traits used by the class. ClassScanner
hasConstant() Verify if class or parent class has constant DerivedClassScanner
hasMethod() Verify if class or parent class has method by given name DerivedClassScanner
hasParentClass() DerivedClassScanner
hasProperty() Verify if class or parent class has property DerivedClassScanner
isAbstract() DerivedClassScanner
isFinal() DerivedClassScanner
isInstantiable() DerivedClassScanner
isInterface() DerivedClassScanner
isTrait() Verify if class is a trait ClassScanner

Method Details

__construct()

Parameter Name Type Description
$classScanner \ClassScanner
$directoryScanner \DirectoryScanner

Returns:

__toString()

Returns: void

export()

Returns: void

getAnnotations()

Get annotations

Parameter Name Type Description
$annotationManager \Annotation\AnnotationManager

Returns: \Annotation\AnnotationCollection

getConstant()

Return a single constant by given name or index of info

Parameter Name Type Description
$constantNameOrInfoIndex string|int

Returns: bool|\ConstantScanner

getConstantNames()

Return a list of constant names

Returns: array

getConstants()

Return a list of constants

Parameter Name Type Description
$namesOnly bool Set

Returns: array|\ConstantScanner[]

getDocBlock()

Return documentation block

Returns: bool|\DocBlockScanner

getDocComment()

Return documentation comment

Returns: null|string

getInterfaces()

Parameter Name Type Description
$returnClassScanners bool

Returns: array

getLineEnd()

Return number of last line

Returns: int|null

getLineStart()

Return number of first line

Returns: int|null

getMethod()

Parameter Name Type Description
$methodNameOrInfoIndex int|string

Returns: \MethodScanner

getMethodNames()

Returns: array

getMethods()

Returns: \MethodScanner[]

getName()

Returns: null|string

getParentClass()

Returns: null|string

getParentClasses()

Returns: array

getProperties()

Parameter Name Type Description
$returnScannerProperty bool

Returns: array

getProperty()

Return a single property by given name or index of info

Parameter Name Type Description
$propertyNameOrInfoIndex string|int

Returns: bool|\PropertyScanner

getPropertyNames()

Return a list of property names

Returns: array

getShortName()

Returns: null|string

getTraitAliases()

Retrieve a list of aliased traits used by the class.

Returns: array

getTraitNames()

Retrieve a list of trait names used by this class.

Returns: array

getTraits()

Retrieve any traits used by the class.

Returns: \ClassScanner[]

hasConstant()

Verify if class or parent class has constant

Parameter Name Type Description
$name string

Returns: bool

hasMethod()

Verify if class or parent class has method by given name

Parameter Name Type Description
$name string

Returns: bool

hasParentClass()

Returns: bool

hasProperty()

Verify if class or parent class has property

Parameter Name Type Description
$name string

Returns: bool

isAbstract()

Returns: bool

isFinal()

Returns: bool

isInstantiable()

Returns: bool

isInterface()

Returns: bool

isTrait()

Verify if class is a trait

Returns: bool

Top